/*
 * Copyright 2011-2017 JacobLee007
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.honeybees.intellij.javadocs.model;

import java.util.List;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * The type Java doc tag.
 *
 * @author Sergey Timofiychuk
 */
public class JavaDocTag {

    private String refParam;
    private String value;
    private List<String> description;

    /**
     * Instantiates a new Java doc tag.
     *
     * @param refParam    the Ref param
     * @param value       the Value
     * @param description the Description
     */
    public JavaDocTag(@Nullable String refParam, @Nullable String value, @NotNull List<String> description) {
        this.refParam = refParam;
        this.value = value;
        this.description = description;
    }

    /**
     * Gets the ref param.
     *
     * @return the Ref param
     */
    @Nullable
    public String getRefParam() {
        return refParam;
    }

    /**
     * Gets the value.
     *
     * @return the Value
     */
    @Nullable
    public String getValue() {
        return value;
    }

    /**
     * Gets the description.
     *
     * @return the Description
     */
    @NotNull
    public List<String> getDescription() {
        return description;
    }

}
